/**
 * Copyright (c) 2009 blurredVision
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
 * associated documentation files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, publish, distribute, 
 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is 
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or 
 * substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT 
 * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT 
 * OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#ifndef __GUI_CANVAS_H__
#define __GUI_CANVAS_H__

#pragma once

#include "Component.h"

namespace gui {

/**
 * \ingroup coreGUI
 *
 * The GUI Canvas class.<br>
 * A Canvas holds other GUI elements as a container.<br>
 * A Canvas can be added to a Frame to make it interactively movable.
 *
 * \date 03-28-2007
 *
 * \author juckel
 * \author dennis
 *
 */
class GUI_EXPORT Canvas : 
	public Component
{
public:
	Canvas(void);
	/// Create a new canvas with a certain title
	Canvas(const std::string &title);
	virtual ~Canvas(void);

	/// Set the title of the canvas
	void setTitle(const std::string &title);

	/// Return the title of the canvas
	const std::string & getTitle() const;

	/** Resizes the canvas to fit all the components stored in it. <br>
	 * The resize algorithm tries to center the components in the canvas. <br>
	 * That means, that the minimum offset of the components in the top-left corner 
	 * of the canvas will be added to the right and lower side.
	 */
	void resize();
	
	/// The draw function
	void draw();

	/// Return the type of the gui element
	virtual inline const int getGUIType() const { return GUI_CANVAS; }

protected:
	std::string m_sTitle;
};

} // namespace

#endif
